/* ************************************************************************

   Copyright:

   License:

   Authors:

************************************************************************ */

/* ************************************************************************



************************************************************************ */

/**
* This class represents a mapscript hashTableObj class.
*
*/
qx.Class.define("mmclient.mapscript.HashTableObj",
{
  extend : qx.core.Object,


  /*
  *****************************************************************************
     CONSTRUCTOR
  *****************************************************************************
  */

  construct : function() {
    qx.core.Object.call(this);
  },


  /*
  *****************************************************************************
     PROPERTIES
  *****************************************************************************
  */

  properties :
  {
    /**
    * Number of hash items.
    *
    */
    numItems :
    {
      check : "Number",
      init : 0
    }
  },


  /*
  *****************************************************************************
     MEMBERS
  *****************************************************************************
  */

  members :
  {
    /**
     * Empties the table of all items.
     *
     * @type member
     * @return {void} 
     */
    clear : function() {},

    /**
     * Returns the value of the item by its key, or "" if the key does not exist.
     *
     * @type member
     * @param key {String} Hash table key.
     * @return {void} 
     */
    get : function(key) {},

    /**
     * Returns the name of the next key or NULL if there is no valid next key. If the input key is NULL, returns the first key.
     *
     * @type member
     * @param key {String} Hash table key.
     * @return {void} 
     */
    nextKey : function(key) {},

    /**
     * Removes the hash item by its key. Returns MS_SUCCESS or MS_FAILURE.
     *
     * @type member
     * @param key {String} Hash table key.
     * @return {void} 
     */
    remove : function(key) {},

    /**
     * Sets a hash item. Returns MS_SUCCESS or MS_FAILURE.
     *
     * @type member
     * @param key {String} Hash table key.
     * @param value {String} Hash table value.
     * @return {void} 
     */
    set : function(key, value) {}
  }
});
